home *** CD-ROM | disk | FTP | other *** search
/ Netrunner 2004 October / NETRUNNER0410.ISO / regular / sleipnir165.exe / {app} / documents / L.eng / Script.txt < prev    next >
Text File  |  2004-06-20  |  18KB  |  762 lines
  1. ==============================================================================
  2.  
  3.   Sleipnir API Reference
  4.  
  5.   Copyright (C) 2002 by Yasuyuki Kashgiwagi.
  6.   All Rights Reserved.
  7.  
  8. ==============================================================================
  9.  
  10. Script of Sleipnir It operates using Windows Scripting Host (WSH).
  11. The scripts below {ini_dir}\scripts\ is read.
  12.  
  13. The folders named $*** does not read.
  14. They are for saving the script for work, and the event script for output.
  15.  
  16. The check of the "Sleipnir option | Script | Enable scripting control of Sleipnir" 
  17. is confirmed using a script. This option is invalid by the default.
  18.  
  19. To the directory "sciprts" Existence of "template_vbs" or "template_js" copies 
  20. the contents at the time of new creation.
  21.  
  22. If the created script is registered as a tool from "tool | customize | tool", 
  23. it can be added to a page menu or a tool bar.
  24.  
  25. If it registers with an address bar extension menu by the 
  26. "application:wscript.exe {INI_DIR} scripts\script name", it can also be used 
  27. from an address bar extension menu.
  28.  
  29. To in addition, URL If it specifies like 
  30. http://www.sample-url.com/<script=test\xxx.vbs>, it is after page reading. 
  31. <ini_dir> \scripts\test\xxx.vbs is performed. 
  32.  
  33. Only the time of extensions being .vbs, .js, and .wsf can perform. Using this 
  34. function should confirm the check of "Sleipnir option|script|Enable scripting 
  35. after pages are loaded". It is peculiar to a document in the script performed 
  36. after page reading as an argument. ID is passed.
  37.  
  38.  
  39. ==============================================================================
  40.  Property
  41. ==============================================================================
  42.  
  43. (R) : Read only. A setup of a value cannot be performed.
  44.  
  45. [string] AddressBarString The string of an Address bar is acquired / set up.
  46. [string] SearchBarString  The string of a Search Bar bar is acquired / set up.
  47. [string] URL              Active document URL is acquired / set up.
  48. [long]   ActiveIndex      The tab position of an active document is acquired / set up.
  49. [string] FavoriteFile     A favorite file is acquired / set up.
  50. [string] AppPath(R)       The directory where Sleipnir.exe exists is returned.
  51. [string] ScriptPath(R)    A directory with the script read is returned.
  52. [string] ResourcePath(R)  The directory of a resource read is returned.
  53. [string] UserPath(R)      The directory of various setup to save is returned.
  54. [string] UserAgent        UserAgent is acquired / set up.
  55. [long]   Handle(R)        The window handle of Sleipnir is returned.
  56. [long]   Result           The result of Sleipnir API is returned.
  57. [long]   Version(R)       The version of Sleipnir is returned.
  58.  
  59. // 1.30 or subsequent ones
  60.  
  61. [bool]   ShiftDown(R)     The state of the Shift key is returned.
  62. [bool]   CtrlDown(R)      The state of the Ctrl key is returned.
  63. [bool]   AltDown(R)       The state of the Alt key is returned.
  64. [bool]   OutputVisible    The visible state of an output bar is acquired / set up.
  65. [long]   OutputCurSel     The selection line of an output bar is acquired / set up.
  66. [string] OutputScript     The script file called when double-clicked for output is acquired / set up.
  67.                           This script is as an argument. /output: Selection line It is passed.
  68.  
  69.  
  70. ==============================================================================
  71.  Method
  72. ==============================================================================
  73.  
  74. ----------------
  75. [long] GetCount
  76. ----------------
  77.  
  78. [Description]
  79.  Return The number of documents currently opened.
  80.  
  81. [Argument]
  82.  Nothing
  83.  
  84. [Return value]
  85.  The number of documents currently opened
  86.  
  87.  
  88. --------------------------------
  89. [long] GetDocumentID(long index)
  90. --------------------------------
  91.  
  92. [Description]
  93.  Get ID peculiar to a document.
  94.  
  95. [Argument]
  96.  index: Tab position (0 - GetCount-1)
  97.  
  98. [Return value]
  99.  ID peculiar to a document
  100.  
  101.  
  102. ------------------------------------
  103. [IDispatch] GetWindowObject(long id)
  104. ------------------------------------
  105.  
  106. [Description]
  107.  Get Window Object.
  108.  
  109. [Argument]
  110.  id: ID peculiar to a document
  111.  
  112. [Return value]
  113.  Windows Object IDispatch
  114.  
  115.  
  116. --------------------------------------
  117. [IDispatch] GetDocumentObject(long id)
  118. --------------------------------------
  119.  
  120. [Description]
  121.  Get HTML Document Object
  122.  
  123. [Argument]
  124.  id: ID peculiar to a document
  125.  
  126. [Return value]
  127.  Document Object IDispatch
  128.  
  129.  
  130. ----------------------------------------
  131. [IDispatch] GetWebBrowserObject(long id)
  132. ----------------------------------------
  133.  
  134. [Description]
  135.  Get WebBrowser Object
  136.  
  137. [Argument]
  138.  id: ID peculiar to a document
  139.  
  140. [Return value]
  141.  WebBrowser Object IDispatch
  142.  
  143.  
  144. ----------------------------------------------
  145. [long] NewWindow(string strUrl, bool bActive)
  146. ----------------------------------------------
  147.  
  148. [Description]
  149.  Open new document.
  150.  
  151. [Argument]
  152.  strUrl:  Document opened newly Url
  153.  bActive: The window opened newly made active 
  154.  
  155. [Return value]
  156.  Opened ID peculiar to a document
  157.  
  158.  
  159. ----------------------
  160. [void] Close(long id)
  161. ----------------------
  162.  
  163. [Description]
  164.  Close the appointed document.
  165.  
  166. [Argument]
  167.  id: ID peculiar to a document
  168.  
  169. [Return value]
  170.  Nothing
  171.  
  172.  
  173. ----------------------------------------
  174. [void] Navigate(long id, string strUrl)
  175. ----------------------------------------
  176.  
  177. [Description]
  178.  Access arbitrary URL by the present document.
  179.  
  180. [Argument]
  181.  id:     ID peculiar to a document
  182.  strUrl: Url to navigate
  183.  
  184. [Return value]
  185.  Nothing
  186.  
  187.  
  188. ------------------------
  189. [long] GetIndex(long id)
  190. ------------------------
  191.  
  192. [Description]
  193.  Get a tab position from ID peculiar to a document.
  194.  
  195. [Argument]
  196.  id: ID peculiar to a document
  197.  
  198. [Return value]
  199.  Tab position
  200.  
  201.  
  202. ------------------------------------
  203. [void] MessageBox(string strMessage)
  204. ------------------------------------
  205.  
  206. [Description]
  207.  Show the message box of Sleipnir
  208.  
  209. [Argument]
  210.  strMessage: The message to display
  211.  
  212. [Return value]
  213.  Nothing
  214.  
  215.  
  216. ------------------
  217. [void] Beep(void)
  218. ------------------
  219.  
  220. [Description]
  221. ü@Beep ë╣é≡û┬éτé╖üB
  222.  Sound beep
  223.  
  224. [Return value]
  225.  Nothing
  226.  
  227.  
  228. ----------------------
  229. [BOOL] IsBusy(long id)
  230. ----------------------
  231.  
  232. [Description]
  233.  A document reads and it judges in inside.
  234.  
  235. [Argument]
  236.  id: ID peculiar to a document
  237.  
  238. [Return value]
  239.  In under reading, it is true.
  240.  
  241.  
  242. ----------------------------------------------------------------------------
  243. [void] SetSecurity(long id, BOOL bJavaScript, BOOL bJava, BOOL bRunActiveX,
  244.                    BOOL bDownloadActiveX, BOOL bPicture, BOOL bSound, 
  245.                    BOOL bVideo)
  246. ----------------------------------------------------------------------------
  247.  
  248. [Description]
  249.  Set up the security of a document.
  250.  
  251. [Argument]
  252.  id:         ID peculiar to a document
  253.  Each value: Each security
  254.  
  255.  
  256. ----------------------------------------
  257. [BOOL] IsJavaScriptEnabled(long id)
  258. [BOOL] IsJavaEnabled(long id)
  259. [BOOL] IsRunActiveXEnabled(long id)
  260. [BOOL] IsDownloadActiveXEnabled(long id)
  261. [BOOL] IsPictureEnabled(long id)
  262. [BOOL] IsSoundEnabled(long id)
  263. [BOOL] IsVideoEnabled(long id)
  264. ----------------------------------------
  265.  
  266. [Description]
  267.  Get the security of a document.
  268.  
  269. [Argument]
  270.  id: ID peculiar to a document
  271.  
  272. [Return value]
  273.  It is true if effective.
  274.  
  275.  
  276. ------------------------------
  277. [BOOL] IsNavigateLock(long id)
  278. ------------------------------
  279.  
  280. [Description]
  281.  It acquires whether a Navigation Lock is effective.
  282.  
  283. [Argument]
  284.  id: ID peculiar to a document
  285.  
  286. [Return value]
  287.  It is true if effective.
  288.  
  289.  
  290. ----------------------------------------------
  291. [void] SetNavigateLock(long id, BOOL bEnable)
  292. ----------------------------------------------
  293.  
  294. [Description]
  295.  Navigation Lock is confirmed/repealed.
  296.  
  297. [Argument]
  298.  id:      ID peculiar to a document
  299.  bEnable: It will be true if it confirms.
  300.  
  301. [Return value]
  302.  Nothing
  303.  
  304.  
  305. ----------------------------------------
  306. [BOOL] SaveFavorite(string strFileName)
  307. ----------------------------------------
  308.  
  309. [Description]
  310.  Save Favorite files.
  311.  
  312. [Argument]
  313.  strFileName: Save file name(it specifies with a full path)
  314.  
  315. [Return value]
  316.  It is true if it is a success.
  317.  
  318.  
  319. ----------------------
  320. [void] SaveClosedURL()
  321. ----------------------
  322.  
  323. [Description]
  324.  Overwrite preservation of the page closed recently is carried out at a file.
  325.  
  326. [Argument]
  327.  Nothing
  328.  
  329. [Return value]
  330.  Nothing
  331.  
  332.  
  333. ------------------------------------------
  334. [BOOL] Search(long id, string strKeyword)
  335. ------------------------------------------
  336.  
  337. [Description]
  338.  Find on this page
  339.  
  340. [Argument]
  341.  strKeyword: Keyword
  342.  
  343. [Return value]
  344.  false will be returned, if a keyword cannot be discovered or it returns to a top keyword.
  345.  
  346.  
  347. ------------------------------------------
  348. [void] Hilight(long id, string strKeyword)
  349. ------------------------------------------
  350.  
  351. [Description]
  352.  Highlight SearchBar String
  353.  
  354. [Argument]
  355.  strKeyword: Keyword
  356.  
  357. [Return value]
  358.  Nothing
  359.  
  360.  
  361. --------------------------------------------------------------------
  362. [void] WriteProfileInt(string strSection, string strKey, long nData)
  363. --------------------------------------------------------------------
  364.  
  365. [Description]
  366.  Wright long type data in <ini_dir>\script.ini.
  367.  
  368. [Argument]
  369.  strSection: Section
  370.  strKey:     Key
  371.  nData:      Data
  372.  
  373. [Return value]
  374.  Nothing
  375.  
  376.  
  377. ----------------------------------------------------------------------------
  378. [void] WriteProfileString(string strSection, string strKey, string strData)
  379. ----------------------------------------------------------------------------
  380.  
  381. [Description]
  382.  Wright string type data in <ini_dir>\script.ini.
  383.  
  384. [Argument]
  385.  strSection: Section
  386.  strKey:     Key
  387.  nData:      Data
  388.  
  389. [Return value]
  390.  Nothing
  391.  
  392.  
  393. ----------------------------------------------------------------------
  394. [long] GetProfileInt(string strSection, string strKey, long nDefault)
  395. ----------------------------------------------------------------------
  396.  
  397. [Description]
  398.  Read long type data in <ini_dir>\script.ini.
  399.  
  400. [Argument]
  401.  strSection: Section
  402.  strKey:     Key
  403.  nDefault:   The value returned when a key does not exist
  404.  
  405. [Return value]
  406.  Data
  407.  
  408.  
  409. ------------------------------------------------------------------------------
  410. [string] GetProfileString(string strSection, string strKey, string strDefault)
  411. ------------------------------------------------------------------------------
  412.  
  413. [Description]
  414.  Read string type data in <ini_dir>\script.ini.
  415.  
  416. [Argument]
  417.  strSection: Section
  418.  strKey:     Key
  419.  nDefault:   The value returned when a key does not exist
  420.  
  421. [Return value]
  422.  Data
  423.  
  424.  
  425. --------------------------------------------------------------------------
  426. [void] WriteProfileIntCipher(string strSection, string strKey, long nData)
  427. --------------------------------------------------------------------------
  428.  
  429. [Description]
  430.  Wright long type data enciphered in <ini_dir>\script.ini.
  431.  
  432. [Argument]
  433.  strSection: Section
  434.  strKey:     Key
  435.  nData:      Data
  436.  
  437. [Return value]
  438.  Nothing
  439.  
  440.  
  441. ------------------------------------------------------------------
  442. [void] WriteProfileStringCipher(string strSection, string strKey,
  443.                                 string strData)
  444. ------------------------------------------------------------------
  445.  
  446. [Description]
  447.  Wright string type data enciphered in <ini_dir>\script.ini.
  448.  
  449. [Argument]
  450.  strSection: Section
  451.  strKey:     Key
  452.  nData:      Data
  453.  
  454. [Return value]
  455.  Nothing
  456.  
  457.  
  458. ----------------------------------------------------------------------------
  459. [long] GetProfileIntCipher(string strSection, string strKey, long nDefault)
  460. ----------------------------------------------------------------------------
  461.  
  462. [Description]
  463.  Read long type data enciphered from <ini_dir>\script.ini.
  464.  
  465. [Argument]
  466.  strSection: Section
  467.  strKey:     Key
  468.  nDefault:   The value returned when a key does not exist
  469.  
  470. [Return value]
  471.  Data
  472.  
  473.  
  474. ------------------------------------------------------------------
  475. [string] GetProfileStringCipher(string strSection, string strKey,
  476.                                 string strDefault)
  477. ------------------------------------------------------------------
  478.  
  479. [Description]
  480.  Read string type data enciphered from <ini_dir>\script.ini.
  481.  
  482. [Argument]
  483.  strSection: Section
  484.  strKey:     Key
  485.  nDefault:   The value returned when a key does not exist
  486.  
  487. [Return value]
  488.  Data
  489.  
  490.  
  491. ----------------------
  492. [BOOL] IsRead(long id)
  493. ----------------------
  494.  
  495. [Description]
  496.  It judges whether the document is already browsed.
  497.  
  498. [Argument]
  499.  id: ID peculiar to a document
  500.  
  501. [Return value]
  502.  Already browsed,true
  503.  
  504.  
  505. ------------------------------------------------------
  506. [string] InputBox(string strPrompt, string strDefault)
  507. ------------------------------------------------------
  508.  
  509. [Description]
  510.  Show dialog which inputs a string
  511.  
  512. [Argument]
  513.  strPrompt:  prompt
  514.  strDefault: Default string
  515.  
  516. [Return value]
  517.  strDefault is returned if it is the string and Cancel which were edited if it was OK.
  518.  #1(OK) or 0(Cancel) are set as a Result property.
  519.  
  520.  
  521. ------------------------------------------
  522. [void] SetAutoRefresh(long id, long nTime)
  523. ------------------------------------------
  524.  
  525. [Description]
  526.  Set Auto Refresh time.
  527.  
  528. [Argument]
  529.  id:    ID peculiar to a document
  530.  nTime: Updating time (0 - 1000 second)
  531.  
  532. [Return value]
  533.  Nothing
  534.  
  535.  
  536. ------------------------------
  537. [long] GetAutoRefresh(long id)
  538. ------------------------------
  539.  
  540. [Description]
  541.  Get Auto Refresh time.
  542.  
  543. [Argument]
  544.  id: ID peculiar to a document
  545.  
  546. [Return value]
  547.  Auto Refresh time (second)
  548.  
  549.  
  550. ------------------------
  551. [long] OutputGetCount()
  552. ------------------------
  553.  
  554. [Description]
  555.  Get number of lines currently outputted to Output.
  556.  
  557. [Argument]
  558.  Nothing
  559.  
  560. [Return value]
  561.  Lines
  562.  
  563.  
  564. ----------------------------------
  565. [void] OutputAddString(string str)
  566. ----------------------------------
  567.  
  568. [Description]
  569.  Add a string to Output.
  570.  
  571. [Argument]
  572.  str: The string to output
  573.  
  574. [Return value]
  575.  Nothing
  576.  
  577.  
  578. ----------------------------------------------
  579. [void] OutputInsertString(long n, string str)
  580. ----------------------------------------------
  581.  
  582. [Description]
  583.  Insert a string in Output.
  584.  
  585. [Argument]
  586.  n:   Insert position
  587.  str: The string to output
  588.  
  589. [Return value]
  590.  Nothing
  591.  
  592.  
  593. --------------------
  594. [void] OutputClear()
  595. --------------------
  596.  
  597. [Description]
  598.  Clear Output.
  599.  
  600. [Argument]
  601.  Nothing
  602.  
  603. [Return value]
  604.  Nothing
  605.  
  606.  
  607. --------------------------------
  608. [string] OutputGetString(long n)
  609. --------------------------------
  610.  
  611. [Description]
  612.  Get a string from Output.
  613.  
  614. [Argument]
  615.  n: The line to acquire
  616.  
  617. [Return value]
  618.  string
  619.  
  620.  
  621. ----------------------------------
  622. [void] OutputDeleteString(long n)
  623. ----------------------------------
  624.  
  625. [Description]
  626.  Delete a line from Output.
  627.  
  628. [Argument]
  629.  n: Delete line number
  630.  
  631. [Return value]
  632.  Nothing
  633.  
  634.  
  635. ----------------------------------------------------------
  636. string MaskedInputBox(string strPrompt, string strDefault)
  637. ----------------------------------------------------------
  638.  
  639. [Description]
  640.  Display the dialog which inputs the character sequence protected with the mask.
  641.  
  642. [Argument]
  643.  strPrompt: Prompt
  644.  strDefault: Default string
  645.  
  646. [Return value]
  647.  In OK, the edited string is returned and, in Cancel, strDefault is returned.
  648.  #1 (O.K.) or 0 (Cancel) are set as a Result property.
  649.  
  650.  
  651. ------------------------------------------------------------------------
  652. [long] GetProfileIntEx(string strSection, string strKey, long nDefault,
  653.                        string strFileName)
  654. ------------------------------------------------------------------------
  655.  
  656. [Description]
  657.  Read long type data from INI file specified by strFileName.
  658.  
  659. [Argument]
  660.  strSection:  Section
  661.  strKey:      key
  662.  nDefault:    The value returned when a key does not exist
  663.  strFileName: The file name which reads a setup
  664.  
  665. [Return value]
  666.  Data
  667.  
  668.  
  669. ------------------------------------------------------------------
  670. [string] GetProfileStringEx(string strSection, string strKey, 
  671.                             string strDefault, string strFileName)
  672. ------------------------------------------------------------------
  673.  
  674. [Description]
  675.  Read string type data from INI file specified by strFileName.
  676.  The string surrounded by "" may be returned in a part of files.
  677.  
  678. [Argument]
  679.  strSection:  Section
  680.  strKey:      key
  681.  strDefault:  The value returned when a key does not exist
  682.  strFileName: The file name which reads a setup
  683.  
  684. [Return value]
  685.  Data
  686.  
  687. ----------------------------------------------------------
  688. [void] DeleteProfileKey(string strSection, string strKey)
  689. ----------------------------------------------------------
  690.  
  691. [Description]
  692.  Delete arbitrary keys from <ini_dir>\script.ini.
  693.  
  694. [Argument]
  695.  strSection: Section
  696.  strKey:     Key
  697.  
  698. [Return value]
  699.  Nothing
  700.  
  701.  
  702. ------------------------------------------------------------
  703. [long] MsgBox(string strPrompt, string strTitle, long lFlag)
  704. ------------------------------------------------------------
  705.  
  706. [Description]
  707.  Call WinAPI::MessageBox
  708.  
  709. [Argument]
  710.  strPrompt: The string displayed on a message box
  711.  strTitle:  The title of a message box
  712.  lFlag:     The same value as WinAPI::MessageBox.
  713.  
  714. [Return value]
  715.  The same return value as WinAPI::MessageBox
  716.  
  717.  
  718. ------------------------
  719. [void] ReloadClosedURL()
  720. ------------------------
  721.  
  722. [Description]
  723.  Reload ClosedURL.ini.
  724.  
  725. [Argument]
  726.  Nothing
  727.  
  728. [Return value]
  729.  Nothing
  730.  
  731.  
  732. --------------------------------------
  733. [void] AddSearchBarHistory(string ss)
  734. --------------------------------------
  735.  
  736. [Description]
  737.  Add an item to the history of Search Bar.When a string already exists, it moves to a head.
  738.  
  739. [Argument]
  740.  ss: The string to add
  741.  
  742. [Return value]
  743.  Nothing
  744.  
  745.  
  746. ------------------------------
  747. [void] ExecCommand(long cmdID)
  748. ------------------------------
  749.  
  750. [Description]
  751.  Specify and perform the arbitrary menus of Sleipnir by cmdID.
  752.  cmdID is referred to from mouse gestures(Gesture.ini).
  753.  
  754. [Argument]
  755.  cmdID: CommandID
  756.  
  757. [Return value]
  758.  Nothing
  759.  
  760.  
  761. ==============================================================================
  762.